package com.example.apidocserver.domain.document.dao;

import com.example.apidocserver.domain.document.entity.ApiParamField;
import com.example.apidocserver.infrastructure.aop.QueryAnno;
import com.example.apidocserver.infrastructure.aop.UpsertAnno;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.Collection;
import java.util.List;

/**
 * 接口文档字段表(ApiParamField)表数据库访问层
 *
 * @author makejava
 * @since 2023-02-24 22:56:57
 */
@Mapper
public interface ApiParamFieldDao {

    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    @QueryAnno
    ApiParamField queryById(Integer id);

    /**
     * 查询指定行数据
     *
     * @return 对象列表
     */
    @QueryAnno
    List<ApiParamField> queryAll();

    /**
     * 查询指定行数据
     *
     * @param apiParamField 查询条件
     * @return 对象列表
     */
    @QueryAnno
    List<ApiParamField> queryByEntity(ApiParamField apiParamField);

    /**
     * 统计总行数
     *
     * @param apiParamField 查询条件
     * @return 总行数
     */
    long count(ApiParamField apiParamField);

    /**
     * 新增数据
     *
     * @param apiParamField 实例对象
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insert(ApiParamField apiParamField);

    /**
     * 新增数据非空使用数据库默认值
     *
     * @param apiParamField 实例对象
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insertSet(ApiParamField apiParamField);

    /**
     * 批量新增数据（MyBatis原生foreach方法）
     *
     * @param entities List<ApiParamField> 实例对象列表
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insertBatch(@Param("entities") List<ApiParamField> entities);

    /**
     * 批量新增或按主键更新数据（MyBatis原生foreach方法）
     *
     * @param entities List<ApiParamField> 实例对象列表
     * @return 影响行数
     * @throws org.springframework.jdbc.BadSqlGrammarException 入参是空List的时候会抛SQL语句错误的异常，请自行校验入参
     */
    @UpsertAnno(isInsert = true, upsert = true)
    int insertOrUpdateBatch(@Param("entities") List<ApiParamField> entities);

    /**
     * 修改数据
     *
     * @param apiParamField 实例对象
     * @return 影响行数
     */
    @UpsertAnno
    int update(ApiParamField apiParamField);

    /**
     * 通过主键删除数据
     *
     * @param id 主键
     * @return 影响行数
     */
    int deleteById(Integer id);

    /**
     * 根据参数id查询字段说明
     *
     * @param paramIds       参数id集合
     * @param onlyEnableFlag 是否只读
     * @return 字段说明对象
     */
    @QueryAnno
    List<ApiParamField> queryByParamIds(@Param("paramIds") Collection<Integer> paramIds,
                                        @Param("onlyEnableFlag") boolean onlyEnableFlag);

    /**
     * 查询相同类型字段
     *
     * @param fieldList 字段集合
     * @return 相似字段集合
     */
    @QueryAnno
    List<ApiParamField> queryLike(@Param("fieldList") List<ApiParamField> fieldList);

    /**
     * 查询参数最大排序值
     *
     * @param paramId 参数id
     * @return 最大排序
     */
    Integer findMaxOrder(@Param("paramId") Integer paramId);

    /**
     * 创建参数与字段关系
     *
     * @param noRltFieldList 字段集合
     * @return 新建字段数量
     */
    @UpsertAnno(isInsert = true)
    int insertRlts(@Param("fieldList") List<ApiParamField> noRltFieldList);

    /**
     * 查询名称显示字段
     *
     * @param likeStr 名称字段
     * @param spaceId 工作空间id
     * @return 字段
     */
    @QueryAnno
    List<ApiParamField> queryLikeName(@Param("likeStr") String likeStr, @Param("spaceId") Integer spaceId);

    /**
     * 工具唯一联合索引查询数据
     *
     * @param insertList 名称字段
     * @return 字段说明字段
     */
    @QueryAnno
    List<ApiParamField> queryUniKeys(@Param("list") List<ApiParamField> insertList);

    /**
     * 批量新增或修改
     *
     * @param updateRltList 字段对象数据集合
     */
    @UpsertAnno(isInsert = true, upsert = true)
    void upsertRlts(@Param("items") List<ApiParamField> updateRltList);

    /**
     * 工具唯一键删除id
     *
     * @param fieldDbList 字段对象数据集合
     */
    int deleteRltsUniKey(@Param("items") List<ApiParamField> fieldDbList);

    /**
     * 根据uniKey查询接口数据
     *
     * @param field 字段对象
     * @return 字段对象
     */
    @QueryAnno
    ApiParamField queryUniKey(@Param("field") ApiParamField field);

    /**
     * 查询工作空间所有字段说明
     *
     * @param spaceId 工作空间id
     * @return 字段说明集合
     */
    @QueryAnno
    List<ApiParamField> findBySpaceId(@Param("spaceId") Integer spaceId);

    /**
     * 查询修改后同uniKey的字段
     *
     * @param field 字段数据
     * @return 字段
     */
    @QueryAnno
    ApiParamField findOtherUniKey(@Param("field") ApiParamField field);

    /**
     * 参数替换字段id
     *
     * @param oldId 旧字段id
     * @param newId 新字段id
     */
    void updateParamField(@Param("oldId") Integer oldId, @Param("newId") Integer newId);

    /**
     * 根据字段id删除参数字段说明
     * @param fieldId 字段id
     */
    void deleteRltByFieldId(@Param("fieldId") Integer fieldId);
}

